home *** CD-ROM | disk | FTP | other *** search
/ Aminet 30 / Aminet 30 (1999)(Schatztruhe)[!][Apr 1999].iso / Aminet / util / wb / uninstall.lha / UnInstall / Developers / Docs next >
Text File  |  1999-02-12  |  3KB  |  79 lines
  1. Trogsoft Uninstall Version 1.0
  2. Developer Documentation
  3.  
  4. If you want to add uninstaller support to your programs, then you will
  5. need to make sure that when the user installs your software using your
  6. software's installer script, a text file must be created by this
  7. script.
  8.  
  9. This text file contains all the neccessary information for the uninstaller
  10. so if/when the user decides to uninstall your software, they can do
  11. it easily and simply using the Uninstall software in this archive.
  12.  
  13. The text file must be named something unique. Usually, this will include
  14. software company, and then the name of the product, and if applicable,
  15. the version number. For instance, 'Trogsoft AddAssign v1' or
  16. 'Digita Wordworth 7'.
  17.  
  18. The file's name cannot include spaces, and must have a '.uni' extension
  19. or it won't be recognised by UnInstaller. Use underscores instead of
  20. spaces.
  21.  
  22. The text file must be created in the Uninstall:Programs/ directory, and
  23. your install script must provide some way of checking if that directory
  24. exists. It's not really good enough to ask the user if they have
  25. UnInstall on their machine. If you are using Commodore (C=) installer
  26. to install your software, then make sure it uses the Exist command
  27. to check for the existence of UnInstall:Programs/
  28.  
  29. If you're using an AmigaDOS script, then use the If Exist method of
  30. checking. The text file must be laid out like this:
  31.  
  32. ====================================
  33.  
  34. UNIFILE
  35. <Name Of Product>
  36.  
  37. WINDOW
  38. <Width>
  39. <Height>
  40.  
  41. PICTURE
  42. <Name Of Picture, If Any>
  43.  
  44. TEXT
  45. <Line(s) of Text>
  46. ENDTEXT
  47.  
  48. FILELIST
  49. <List of files to uninstall>
  50.  
  51. ====================================
  52.  
  53. The UNIFILE line must be present for the uninstall to work. If UNIFILE
  54. is not present, then UnInstaller will refuse to work with the file.
  55. <Name Of Product> is the full name of your product, and can include
  56. spaces. After missing a line (COMPULSARY), you get the WINDOW command.
  57. Below this are the width and height of the automatically centred
  58. window which will appear when your product is uninstalling.
  59.  
  60. PICTURE refers to a picture in the 'UnInstall:Art/' directory. If you
  61. want to add your own, make sure your installer script does it when your
  62. product is being installed, then it will be displayed when your
  63. product is being uninstalled too. It must be 16 colours and in IFF
  64. format. If you don't want a picture type 'None' (case sensetive).
  65.  
  66. TEXT is the start of the text which will appear in your window, and
  67. if you have a picture too, the text will appear under it. There
  68. can be any number of lines of text, as long as you put ENDTEXT at the
  69. end of it.
  70.  
  71. Finally, FILELIST starts off the list of files which are to be removed.
  72. The added advantage of installing your product using the C= Installer
  73. is that you can add pathnames to this text file when it is created,
  74. The list of files can include standard AmigaDOS wildcards and the
  75. 'All' keyword.
  76.  
  77. IE, UCM:#? All
  78.     PPaint:#? All
  79.